/*
 * $Id: FacesResult.java 651946 2008-04-27 13:41:38Z apetrelli $
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package haaproject.webwork.jsf;

import javax.faces.application.ViewHandler;
import javax.faces.component.UIViewRoot;
import javax.faces.context.FacesContext;

import com.opensymphony.xwork.ActionInvocation;
import com.opensymphony.xwork.Result;

/**
 * Executes the JSF render phase
 */
public class FacesResult extends StrutsResultSupport implements Result {

	private static final long serialVersionUID = -3548970638740937804L;

	public FacesResult() {
		super();
	}

	public FacesResult(String location) {
		super(location);
	}

	/**
	 * Checks to see if we need to build a new JSF ViewId from the Struts Result config and then renders the result by
	 * delegating to the FacesRender.render().
	 * 
	 * @see org.apache.struts2.dispatcher.StrutsResultSupport#doExecute(String, ActionInvocation)
	 */
	protected void doExecute(String finalLocation, ActionInvocation invocation) throws Exception {
		performNavigation(finalLocation, FacesContext.getCurrentInstance());
		new FacesRender().render(FacesContext.getCurrentInstance());
	}

	/**
	 * Compares the Struts Result uri to the faces viewId. If they are different use the Struts uri to build a new faces
	 * viewId.
	 * 
	 * @param finalLocation
	 *            The result uri
	 * @param facesContext
	 *            The FacesContext
	 */
	private void performNavigation(String finalLocation, FacesContext facesContext) {
		String facesViewId = facesContext.getViewRoot().getViewId();
		if (finalLocation != null) {
			if (finalLocation.equals(facesViewId) == false) {
				ViewHandler viewHandler = facesContext.getApplication().getViewHandler();
				UIViewRoot viewRoot = viewHandler.createView(facesContext, finalLocation);
				facesContext.setViewRoot(viewRoot);
				facesContext.renderResponse();
			}
		}
	}

}
